<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Pooling Functions</title>
<title>CMSIS-NN: Pooling Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="printComponentTabs.js"></script>
<script type="text/javascript" src="cmsis_footer.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 46px;">
  <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">CMSIS-NN
   &#160;<span id="projectnumber">Version 3.1.0</span>
   </div>
   <div id="projectbrief">CMSIS NN Software Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
    <ul class="tablist">
      <script type="text/javascript">
		<!--
		writeComponentTabs.call(this);
		//-->
      </script>
	  </ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
      <li><a href="modules.html"><span>Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__Pooling.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Pooling Functions<div class="ingroups"><a class="el" href="group__groupNN.html">Neural Network Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8f2a6e5c4717f05dde9c7244e0987c31"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga8f2a6e5c4717f05dde9c7244e0987c31">arm_avgpool_s16</a> (const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *ctx, const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *pool_params, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *input_dims, const q15_t *src, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *filter_dims, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *output_dims, q15_t *dst)</td></tr>
<tr class="separator:ga8f2a6e5c4717f05dde9c7244e0987c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac5f8a447fac56e1c48f353a746ec411a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#gac5f8a447fac56e1c48f353a746ec411a">arm_avgpool_s16_get_buffer_size</a> (const int output_x, const int ch_src)</td></tr>
<tr class="memdesc:gac5f8a447fac56e1c48f353a746ec411a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the required buffer size for S16 average pooling function.  <a href="#gac5f8a447fac56e1c48f353a746ec411a">More...</a><br/></td></tr>
<tr class="separator:gac5f8a447fac56e1c48f353a746ec411a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafa69cdb8a711ddef477d330204fa412c"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#gafa69cdb8a711ddef477d330204fa412c">arm_avgpool_s8</a> (const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *ctx, const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *pool_params, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *input_dims, const q7_t *src, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *filter_dims, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *output_dims, q7_t *dst)</td></tr>
<tr class="memdesc:gafa69cdb8a711ddef477d330204fa412c"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 average pooling function.  <a href="#gafa69cdb8a711ddef477d330204fa412c">More...</a><br/></td></tr>
<tr class="separator:gafa69cdb8a711ddef477d330204fa412c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08263590a94c39b4c1c199501ca166e4"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga08263590a94c39b4c1c199501ca166e4">arm_avgpool_s8_get_buffer_size</a> (const int output_x, const int ch_src)</td></tr>
<tr class="memdesc:ga08263590a94c39b4c1c199501ca166e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the required buffer size for S8 average pooling function.  <a href="#ga08263590a94c39b4c1c199501ca166e4">More...</a><br/></td></tr>
<tr class="separator:ga08263590a94c39b4c1c199501ca166e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8bc3b3dd1fcf5ac462aa28bdddc0e3bb"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga8bc3b3dd1fcf5ac462aa28bdddc0e3bb">arm_max_pool_s16</a> (const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *ctx, const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *pool_params, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *input_dims, const int16_t *src, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *filter_dims, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *output_dims, int16_t *dst)</td></tr>
<tr class="memdesc:ga8bc3b3dd1fcf5ac462aa28bdddc0e3bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">s16 max pooling function.  <a href="#ga8bc3b3dd1fcf5ac462aa28bdddc0e3bb">More...</a><br/></td></tr>
<tr class="separator:ga8bc3b3dd1fcf5ac462aa28bdddc0e3bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3628978b2ab0b43d8f8723118c12acc4"><td class="memItemLeft" align="right" valign="top">arm_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga3628978b2ab0b43d8f8723118c12acc4">arm_max_pool_s8</a> (const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *ctx, const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *pool_params, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *input_dims, const q7_t *src, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *filter_dims, const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *output_dims, q7_t *dst)</td></tr>
<tr class="memdesc:ga3628978b2ab0b43d8f8723118c12acc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">s8 max pooling function.  <a href="#ga3628978b2ab0b43d8f8723118c12acc4">More...</a><br/></td></tr>
<tr class="separator:ga3628978b2ab0b43d8f8723118c12acc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#ga99afcdcc61eaf429ab3ee823702e44ce">arm_maxpool_q7_HWC</a> (q7_t *Im_in, const uint16_t dim_im_in, const uint16_t ch_im_in, const uint16_t dim_kernel, const uint16_t padding, const uint16_t stride, const uint16_t dim_im_out, q7_t *bufferA, q7_t *Im_out)</td></tr>
<tr class="memdesc:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 max pooling function.  <a href="#ga99afcdcc61eaf429ab3ee823702e44ce">More...</a><br/></td></tr>
<tr class="separator:ga99afcdcc61eaf429ab3ee823702e44ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Pooling.html#gae4a7b07f97ec4313524c9fb9fbcb1f6a">arm_avepool_q7_HWC</a> (q7_t *Im_in, const uint16_t dim_im_in, const uint16_t ch_im_in, const uint16_t dim_kernel, const uint16_t padding, const uint16_t stride, const uint16_t dim_im_out, q7_t *bufferA, q7_t *Im_out)</td></tr>
<tr class="memdesc:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Q7 average pooling function.  <a href="#gae4a7b07f97ec4313524c9fb9fbcb1f6a">More...</a><br/></td></tr>
<tr class="separator:gae4a7b07f97ec4313524c9fb9fbcb1f6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Perform pooling functions, including max pooling and average pooling </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gae4a7b07f97ec4313524c9fb9fbcb1f6a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void arm_avepool_q7_HWC </td>
          <td>(</td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>Im_in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>dim_im_in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>ch_im_in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>dim_kernel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>padding</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>stride</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>dim_im_out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>bufferA</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>Im_out</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_in</td><td>pointer to input tensor </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_in</td><td>input tensor dimention </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ch_im_in</td><td>number of input tensor channels </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel</td><td>filter kernel size </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">padding</td><td>padding sizes </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>convolution stride </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_out</td><td>output tensor dimension </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">bufferA</td><td>pointer to buffer space for input </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_out</td><td>pointer to output tensor</td></tr>
  </table>
  </dd>
</dl>
<p><b>Buffer size:</b></p>
<p>bufferA size: 2*dim_im_out*ch_im_in</p>
<p>The pooling function is implemented as split x-pooling then y-pooling.</p>
<p>This pooling function is input-destructive. Input data is undefined after calling this function. </p>

<p>References <a class="el" href="group__nndata__convert.html#gae349de4dba8d253c89d45794ccf05680">arm_q7_to_q15_no_shift()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8f2a6e5c4717f05dde9c7244e0987c31"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">arm_status arm_avgpool_s16 </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *&#160;</td>
          <td class="paramname"><em>pool_params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>input_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const q15_t *&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>filter_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>output_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q15_t *&#160;</td>
          <td class="paramname"><em>dst</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>References <a class="el" href="structcmsis__nn__pool__params.html#a5d98c2ed7ab19a021a07175764e95a26">cmsis_nn_pool_params::activation</a>, <a class="el" href="structcmsis__nn__dims.html#ac9c268ab90554ab8ea2c3d76ecf1ed6c">cmsis_nn_dims::c</a>, <a class="el" href="structcmsis__nn__tile.html#a13c54be71aa552c2bc76d12032a3d092">cmsis_nn_tile::h</a>, <a class="el" href="structcmsis__nn__dims.html#a471946ee336572a5a96eeb0894e6005a">cmsis_nn_dims::h</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="structcmsis__nn__activation.html#a5fefc67d8979f6a9efe36330b9ba81cf">cmsis_nn_activation::max</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>, <a class="el" href="structcmsis__nn__activation.html#a88a2ecd4bda8cd5f339c826df578585a">cmsis_nn_activation::min</a>, <a class="el" href="structcmsis__nn__pool__params.html#aba41d8fba7aca6871e7a67f0e6c63346">cmsis_nn_pool_params::padding</a>, <a class="el" href="structcmsis__nn__pool__params.html#a64a4ccb624b7c12ca3e9f3532da58b3a">cmsis_nn_pool_params::stride</a>, <a class="el" href="structcmsis__nn__tile.html#a9f99b4e1164c76f4ed6b32648d454283">cmsis_nn_tile::w</a>, and <a class="el" href="structcmsis__nn__dims.html#a30b8961cc2f84ff79c399c31ff3563c0">cmsis_nn_dims::w</a>.</p>

</div>
</div>
<a class="anchor" id="gac5f8a447fac56e1c48f353a746ec411a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t arm_avgpool_s16_get_buffer_size </td>
          <td>(</td>
          <td class="paramtype">const int&#160;</td>
          <td class="paramname"><em>dim_dst_width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int&#160;</td>
          <td class="paramname"><em>ch_src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_dst_width</td><td>output tensor dimension </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ch_src</td><td>number of input tensor channels </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns required buffer size in bytes </dd></dl>

</div>
</div>
<a class="anchor" id="gafa69cdb8a711ddef477d330204fa412c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">arm_status arm_avgpool_s8 </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *&#160;</td>
          <td class="paramname"><em>pool_params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>input_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const q7_t *&#160;</td>
          <td class="paramname"><em>input_data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>filter_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>output_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>output_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pool_params</td><td>Pooling parameters </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">input_dims</td><td>Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">input_data</td><td>Input (activation) data pointer. Data type: int8 </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">filter_dims</td><td>Filter tensor dimensions. Format: [H, W] Argument N and C are not used. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">output_dims</td><td>Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">output_data</td><td>Output data pointer. Data type: int8 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code> - Successful operation</dd></dl>
<ul>
<li>Supported Framework: TensorFlow Lite </li>
</ul>

<p>References <a class="el" href="structcmsis__nn__pool__params.html#a5d98c2ed7ab19a021a07175764e95a26">cmsis_nn_pool_params::activation</a>, <a class="el" href="group__Pooling.html#ga08263590a94c39b4c1c199501ca166e4">arm_avgpool_s8_get_buffer_size()</a>, <a class="el" href="structcmsis__nn__context.html#a3e613ad30f12df59853a1b3565212702">cmsis_nn_context::buf</a>, <a class="el" href="structcmsis__nn__dims.html#ac9c268ab90554ab8ea2c3d76ecf1ed6c">cmsis_nn_dims::c</a>, <a class="el" href="structcmsis__nn__tile.html#a13c54be71aa552c2bc76d12032a3d092">cmsis_nn_tile::h</a>, <a class="el" href="structcmsis__nn__dims.html#a471946ee336572a5a96eeb0894e6005a">cmsis_nn_dims::h</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="structcmsis__nn__activation.html#a5fefc67d8979f6a9efe36330b9ba81cf">cmsis_nn_activation::max</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>, <a class="el" href="structcmsis__nn__activation.html#a88a2ecd4bda8cd5f339c826df578585a">cmsis_nn_activation::min</a>, <a class="el" href="structcmsis__nn__pool__params.html#aba41d8fba7aca6871e7a67f0e6c63346">cmsis_nn_pool_params::padding</a>, <a class="el" href="structcmsis__nn__pool__params.html#a64a4ccb624b7c12ca3e9f3532da58b3a">cmsis_nn_pool_params::stride</a>, <a class="el" href="structcmsis__nn__tile.html#a9f99b4e1164c76f4ed6b32648d454283">cmsis_nn_tile::w</a>, and <a class="el" href="structcmsis__nn__dims.html#a30b8961cc2f84ff79c399c31ff3563c0">cmsis_nn_dims::w</a>.</p>

</div>
</div>
<a class="anchor" id="ga08263590a94c39b4c1c199501ca166e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t arm_avgpool_s8_get_buffer_size </td>
          <td>(</td>
          <td class="paramtype">const int&#160;</td>
          <td class="paramname"><em>dim_dst_width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int&#160;</td>
          <td class="paramname"><em>ch_src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_dst_width</td><td>output tensor dimension </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ch_src</td><td>number of input tensor channels </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns required buffer size in bytes </dd></dl>

<p>Referenced by <a class="el" href="group__Pooling.html#gafa69cdb8a711ddef477d330204fa412c">arm_avgpool_s8()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8bc3b3dd1fcf5ac462aa28bdddc0e3bb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">arm_status arm_max_pool_s16 </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *&#160;</td>
          <td class="paramname"><em>pool_params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>input_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int16_t *&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>filter_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>output_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int16_t *&#160;</td>
          <td class="paramname"><em>dst</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pool_params</td><td>Pooling parameters </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">input_dims</td><td>Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Input (activation) data pointer. The input tensor must not overlap with the output tensor. Data type: int16 </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">filter_dims</td><td>Filter tensor dimensions. Format: [H, W] Argument N and C are not used. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">output_dims</td><td>Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">dst</td><td>Output data pointer. Data type: int16 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code> - Successful operation</dd></dl>
<ul>
<li>Supported Framework: TensorFlow Lite </li>
</ul>

<p>References <a class="el" href="structcmsis__nn__pool__params.html#a5d98c2ed7ab19a021a07175764e95a26">cmsis_nn_pool_params::activation</a>, <a class="el" href="structcmsis__nn__dims.html#ac9c268ab90554ab8ea2c3d76ecf1ed6c">cmsis_nn_dims::c</a>, <a class="el" href="arm__max__pool__s16_8c.html#a464e5d2cf70e82eb27be23b94a793cf6">clamp_output()</a>, <a class="el" href="arm__max__pool__s16_8c.html#a61d8f1ffa151d8a3327aea577f8c63a3">compare_and_replace_if_larger()</a>, <a class="el" href="structcmsis__nn__tile.html#a13c54be71aa552c2bc76d12032a3d092">cmsis_nn_tile::h</a>, <a class="el" href="structcmsis__nn__dims.html#a471946ee336572a5a96eeb0894e6005a">cmsis_nn_dims::h</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="structcmsis__nn__activation.html#a5fefc67d8979f6a9efe36330b9ba81cf">cmsis_nn_activation::max</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>, <a class="el" href="structcmsis__nn__activation.html#a88a2ecd4bda8cd5f339c826df578585a">cmsis_nn_activation::min</a>, <a class="el" href="structcmsis__nn__pool__params.html#aba41d8fba7aca6871e7a67f0e6c63346">cmsis_nn_pool_params::padding</a>, <a class="el" href="structcmsis__nn__pool__params.html#a64a4ccb624b7c12ca3e9f3532da58b3a">cmsis_nn_pool_params::stride</a>, <a class="el" href="structcmsis__nn__tile.html#a9f99b4e1164c76f4ed6b32648d454283">cmsis_nn_tile::w</a>, and <a class="el" href="structcmsis__nn__dims.html#a30b8961cc2f84ff79c399c31ff3563c0">cmsis_nn_dims::w</a>.</p>

</div>
</div>
<a class="anchor" id="ga3628978b2ab0b43d8f8723118c12acc4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">arm_status arm_max_pool_s8 </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__context.html">cmsis_nn_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__pool__params.html">cmsis_nn_pool_params</a> *&#160;</td>
          <td class="paramname"><em>pool_params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>input_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const q7_t *&#160;</td>
          <td class="paramname"><em>input_data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>filter_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcmsis__nn__dims.html">cmsis_nn_dims</a> *&#160;</td>
          <td class="paramname"><em>output_dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>output_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">ctx</td><td>Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pool_params</td><td>Pooling parameters </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">input_dims</td><td>Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">input_data</td><td>Input (activation) data pointer. The input tensor must not overlap with the output tensor. Data type: int8 </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">filter_dims</td><td>Filter tensor dimensions. Format: [H, W] Argument N and C are not used. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">output_dims</td><td>Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN. </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">output_data</td><td>Output data pointer. Data type: int8 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function returns <code>ARM_MATH_SUCCESS</code> - Successful operation</dd></dl>
<ul>
<li>Supported Framework: TensorFlow Lite </li>
</ul>

<p>References <a class="el" href="structcmsis__nn__pool__params.html#a5d98c2ed7ab19a021a07175764e95a26">cmsis_nn_pool_params::activation</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#a085459f6280c8f586ddd64998dece532">arm_memcpy_q7()</a>, <a class="el" href="structcmsis__nn__dims.html#ac9c268ab90554ab8ea2c3d76ecf1ed6c">cmsis_nn_dims::c</a>, <a class="el" href="arm__max__pool__s8_8c.html#ae73d902e6c38cf63ab235d6c4a3ff3b0">clamp_output()</a>, <a class="el" href="arm__max__pool__s8_8c.html#a3b21bd4a5703839f9ffa5407502c302c">compare_and_replace_if_larger_q7()</a>, <a class="el" href="structcmsis__nn__tile.html#a13c54be71aa552c2bc76d12032a3d092">cmsis_nn_tile::h</a>, <a class="el" href="structcmsis__nn__dims.html#a471946ee336572a5a96eeb0894e6005a">cmsis_nn_dims::h</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#ad935f1ff1a50822e317bdb321ce991ad">MAX</a>, <a class="el" href="structcmsis__nn__activation.html#a5fefc67d8979f6a9efe36330b9ba81cf">cmsis_nn_activation::max</a>, <a class="el" href="arm__nnsupportfunctions_8h.html#adcd021ac91d43a62b2cdecf9a5b971a7">MIN</a>, <a class="el" href="structcmsis__nn__activation.html#a88a2ecd4bda8cd5f339c826df578585a">cmsis_nn_activation::min</a>, <a class="el" href="structcmsis__nn__pool__params.html#aba41d8fba7aca6871e7a67f0e6c63346">cmsis_nn_pool_params::padding</a>, <a class="el" href="structcmsis__nn__pool__params.html#a64a4ccb624b7c12ca3e9f3532da58b3a">cmsis_nn_pool_params::stride</a>, <a class="el" href="structcmsis__nn__tile.html#a9f99b4e1164c76f4ed6b32648d454283">cmsis_nn_tile::w</a>, and <a class="el" href="structcmsis__nn__dims.html#a30b8961cc2f84ff79c399c31ff3563c0">cmsis_nn_dims::w</a>.</p>

</div>
</div>
<a class="anchor" id="ga99afcdcc61eaf429ab3ee823702e44ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void arm_maxpool_q7_HWC </td>
          <td>(</td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>Im_in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>dim_im_in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>ch_im_in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>dim_kernel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>padding</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>stride</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint16_t&#160;</td>
          <td class="paramname"><em>dim_im_out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>bufferA</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">q7_t *&#160;</td>
          <td class="paramname"><em>Im_out</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_in</td><td>pointer to input tensor </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_in</td><td>input tensor dimention </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ch_im_in</td><td>number of input tensor channels </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_kernel</td><td>filter kernel size </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">padding</td><td>padding sizes </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>convolution stride </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dim_im_out</td><td>output tensor dimension </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">bufferA</td><td>Not used </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">Im_out</td><td>pointer to output tensor</td></tr>
  </table>
  </dd>
</dl>
<p>The pooling function is implemented as split x-pooling then y-pooling.</p>
<p>This pooling function is input-destructive. Input data is undefined after calling this function. </p>

<p>References <a class="el" href="arm__max__pool__s8_8c.html#a3b21bd4a5703839f9ffa5407502c302c">compare_and_replace_if_larger_q7()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">
      <script type="text/javascript">
        <!--
        writeFooter.call(this);
        //-->
      </script>    
    </li>
  </ul>
</div>
</body>
</html>
